Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Do not install tests in site-packages #139

Merged
merged 1 commit into from
Mar 14, 2025
Merged

Do not install tests in site-packages #139

merged 1 commit into from
Mar 14, 2025

Conversation

musicinmybrain
Copy link
Contributor

Exclude tests from find_packages().

Before this PR,

$ python3 -m venv _e
$ . _e/bin/activate
$ pip install msal-extensions
$ ls _e/lib/python3*/site-packages/tests/
cache_file_generator.py  __init__.py      __pycache__               test_cache_lock_file_perf.py  test_macos_backend.py  test_windows_backend.py
http_client.py           lock_acquire.py  test_agnostic_backend.py  test_crossplatlock.py         test_persistence.py

Obviously, we don’t want to install the tests as a top-level tests package. This is wrong and risks confusion and conflicts in a virtualenv, and it is even worse in a system-wide distribution package.

This appears to be a regression in 1.3.0, accidentally triggered by the addition of tests/__init__.py in 4b90cc8.

I can also reproduce the problem in a git checkout, working on dev (version numbers are 1.2.0 because #138 hasn’t been merged yet):

$ python3 -m build
[…]
creating '/home/ben/src/forks/microsoft-authentication-extensions-for-python/dist/.tmp-zepss87b/msal_extensions-1.2.0-py3-none-any.whl' and adding 'build/bdist.linux-x86_64/wheel' to it
adding 'msal_extensions/__init__.py'
adding 'msal_extensions/cache_lock.py'
adding 'msal_extensions/filelock.py'
adding 'msal_extensions/libsecret.py'
adding 'msal_extensions/osx.py'
adding 'msal_extensions/persistence.py'
adding 'msal_extensions/token_cache.py'
adding 'msal_extensions/windows.py'
adding 'tests/__init__.py'
adding 'tests/cache_file_generator.py'
adding 'tests/http_client.py'
adding 'tests/lock_acquire.py'
adding 'tests/test_agnostic_backend.py'
adding 'tests/test_cache_lock_file_perf.py'
adding 'tests/test_crossplatlock.py'
adding 'tests/test_macos_backend.py'
adding 'tests/test_persistence.py'
adding 'tests/test_windows_backend.py'
adding 'msal_extensions-1.2.0.dist-info/LICENSE'
adding 'msal_extensions-1.2.0.dist-info/METADATA'
adding 'msal_extensions-1.2.0.dist-info/WHEEL'
adding 'msal_extensions-1.2.0.dist-info/top_level.txt'
adding 'msal_extensions-1.2.0.dist-info/RECORD'
removing build/bdist.linux-x86_64/wheel
Successfully built msal_extensions-1.2.0.tar.gz and msal_extensions-1.2.0-py3-none-any.whl

After this PR, the tests are no longer included in the wheel:

$ python3 -m build
[…]
creating '/home/ben/src/forks/microsoft-authentication-extensions-for-python/dist/.tmp-t_sgk6x7/msal_extensions-1.2.0-py3-none-any.whl' and adding 'build/bdist.linux-x86_64/wheel' to it
adding 'msal_extensions/__init__.py'
adding 'msal_extensions/cache_lock.py'
adding 'msal_extensions/filelock.py'
adding 'msal_extensions/libsecret.py'
adding 'msal_extensions/osx.py'
adding 'msal_extensions/persistence.py'
adding 'msal_extensions/token_cache.py'
adding 'msal_extensions/windows.py'
adding 'msal_extensions-1.2.0.dist-info/LICENSE'
adding 'msal_extensions-1.2.0.dist-info/METADATA'
adding 'msal_extensions-1.2.0.dist-info/WHEEL'
adding 'msal_extensions-1.2.0.dist-info/top_level.txt'
adding 'msal_extensions-1.2.0.dist-info/RECORD'
removing build/bdist.linux-x86_64/wheel
Successfully built msal_extensions-1.2.0.tar.gz and msal_extensions-1.2.0-py3-none-any.whl

@rayluo rayluo linked an issue Mar 14, 2025 that may be closed by this pull request
tests are shipped as a module with the package #140
Closed
@rayluo rayluo mentioned this pull request Mar 14, 2025
Closed
@rayluo rayluo merged commit 76c91d1 into AzureAD:dev Mar 14, 2025
1 check passed
@rayluo
Copy link
Contributor

rayluo commented Mar 14, 2025

Version 1.3.1 is shipped.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rayluo rayluo rayluo approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

tests are shipped as a module with the package
2 participants
@musicinmybrain @rayluo